[index]

List Function

Syntax: To get a list of objects that match certain criteria: the list of [layer] {objects | <object types>} {at <point> | within <rect>} [with [property] <custom property name>] or list([layer] {objects | <object types>} {at <point> | within <rect>} [with [property] <custom property name]) For files: the list of files [of type <type>] [in <directory>] To get a list of files in the specified directory: the list of files [of <type>] [in <directory>]

Description

The list function serves to purposes. It returns references for all objects that match the specified criteria. The returned list is a set of object references separated by carriage returns. The object references take the following format: <layer> object id <id> of <layer> id <id> of stack <stack name> The list function can be used to do the following: The at <point> clause limits the returned list to those objects whose rectangle encompasses the card coordinates <point>. The within <rect> clause limits the returned list to those objects that overlap or lie within the card coordinates of <rect>. The with [property] <custom property name> clause limits the returned list to those objects that have the named property. The second purpose of the list function is to return a list of files in the specified directory. The list of files function returns a return-separated list of filenames in the given directory. The <type> is the extension (a 3-character string in Windows, and a 4-character file type on the Macintosh.) If <type> is omitted, the default is to list all types of files in the given directory. If <directory> is omitted, then the default is to list the files in the current directory.

Examples

The following statement returns all files of the form *.txt (the conventional extension for text files) in the DOS directory "C:\myfiles": the list of files of type "TXT" in "c:\myfiles"